Add canonicalUrl to point to grafana.com/docs/k6 pages #1429
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ppcano
approved these changes
Nov 29, 2023
jdbaldry
reviewed
Nov 30, 2023
There was a problem hiding this comment.
Spotted some 404s:
src/data/markdown/translated-guides/en/02 Using k6/10 Protocols/04 SSL-TLS/Online Certificate Status Protocol -OCSP-.md:canonicalUrl: https://grafana.com/docs/k6/latest/using-k6/protocols/ssl-tls/online-certificate-status-protocol-ocsp/
404
--
src/data/markdown/translated-guides/en/06 Test Types/00 Load test types.md:# canonicalUrl: https://grafana.com/load-testing/load-testing-types/
404
--
src/data/markdown/docs/40 xk6-disruptor/01 Get started/04 Expose Your Application.md:canonicalUrl: https://grafana.com/docs/k6/latest/testing-guides/injecting-faults-with-xk6-disruptor/expose-your-application/
404
--
src/data/markdown/docs/40 xk6-disruptor/02 Explanations/01 How it works.md:canonicalUrl: https://grafana.com/docs/k6/latest/testing-guides/injecting-faults-with-xk6-disruptor/how-it-works/
404
Here are some also interesting canonicals that might need double checking. I considered them interesting if they didn't point to a https://grafana.com/docs/k6/latest/ or https://grafana.com/docs/grafana-cloud/k6/ page:
src/data/markdown/translated-guides/en/08 Misc/04 k6 REST API.md:canonicalUrl: https://grafana.com/docs/k6
src/data/markdown/translated-guides/en/02 Using k6/17 HTTP debugging.md:canonicalUrl: https://grafana.com/docs/k6
src/data/markdown/translated-guides/en/02 Using k6/20 Workaround Iteration Duration.md:canonicalUrl: https://grafana.com/docs/k6
src/data/markdown/translated-guides/en/02 Using k6/19 Javascript Compatibility Mode.md:canonicalUrl: https://grafana.com/docs/k6
src/data/markdown/translated-guides/en/06 Test Types/01 Smoke Testing.md:# canonicalUrl: https://grafana.com/
src/data/markdown/translated-guides/en/06 Test Types/02 Load Testing.md:# canonicalUrl: https://grafana.com/
src/data/markdown/translated-guides/en/06 Test Types/07-breakpoint-testing.md:# canonicalUrl: https://grafana.com/
src/data/markdown/translated-guides/en/06 Test Types/05 Soak Testing.md:# canonicalUrl: https://grafana.com/
src/data/markdown/translated-guides/en/06 Test Types/03 Stress testing.md:# canonicalUrl: https://grafana.com/
src/data/markdown/translated-guides/en/06 Test Types/00 Load test types.md:# canonicalUrl: https://grafana.com/load-testing/load-testing-types/
src/data/markdown/translated-guides/en/Test Types.md:# canonicalUrl: https://grafana.com/
src/data/markdown/translated-guides/en/07 Testing Guides/03 Load testing websites.md:# canonicalUrl: https://grafana.com/
src/data/markdown/translated-guides/en/07 Testing Guides/01 API load testing.md:canonicalUrl: https://grafana.com/docs/k6
Seven canonicals are https://grafana.com/ and five go to 5 https://grafana.com/docs/k6
Mostly looks good to me!
|
In case it's useful, the script I used was: #!/usr/bin/env bash
IFS=$'\n'
for canonical in $(rg --no-heading canonicalUrl: src/data/markdown); do
echo "${canonical}"
url=${canonical##* }
curl -Ls -o /dev/null -w '%{http_code}\n' "${url}"
sleep 0.1
doneAnd then I put the output into a file called $ # Find 404s.
$ grep '^4..$' -B 1 output.txt
$ # Find all canonicals that look unusual
$ grep -vE '([0-9]{3}|https://grafana.com/docs/(grafana-cloud/|k6/latest/).*)$' output.txt
$ # Count repeated canonicals
$ grep -o -E 'https://.*$' output.txt | sort | uniq -c | grep -v 1 |
|
Thanks @jdbaldry! For the 404s you mentioned, I opened a PR on the website repo to fix 3 of them, and one is a commented-out URL. For the other ones you found, a few of them are also set as comments until we have the new marketing pages up, and I removed a few of the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update canonical URL for all the k6.io/docs pages to point to the grafana.com/docs/k6 version.